<!DOCTYPE html>
<html lang="en">
<head>
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=0"/>
    <meta charset="utf-8"/>
    <title>     &raquo; \
</title>
    <meta name="author" content=""/>
    <meta name="description" content=""/>

            <link href="../css/template.css" rel="stylesheet" media="all"/>
    
            <!--[if lt IE 9]>
        <script src="https://html5shim.googlecode.com/svn/trunk/html5.js" type="text/javascript"></script>
        <![endif]-->
        <script src="../js/jquery-1.7.1.min.js" type="text/javascript"></script>
        <script src="../js/jquery-ui-1.8.2.custom.min.js" type="text/javascript"></script>
        <script src="../js/jquery.mousewheel.min.js" type="text/javascript"></script>
        <script src="../js/bootstrap.js" type="text/javascript"></script>
        <script src="../js/template.js" type="text/javascript"></script>
        <script src="../js/prettify/prettify.min.js" type="text/javascript"></script>
    
            <link rel="shortcut icon" href="../img/favicon.ico"/>
        <link rel="apple-touch-icon" href="../img/apple-touch-icon.png"/>
        <link rel="apple-touch-icon" sizes="72x72" href="../img/apple-touch-icon-72x72.png"/>
        <link rel="apple-touch-icon" sizes="114x114" href="../img/apple-touch-icon-114x114.png"/>
    </head>
<body>

        <div class="navbar navbar-fixed-top">
        <div class="navbar-inner">
            <div class="container">
                <a class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
                    <span class="icon-bar"></span> <span class="icon-bar"></span>
                    <span class="icon-bar"></span> </a>
                <a class="brand" href="../index.html">API Documentation</a>

                <div class="nav-collapse">
                    <ul class="nav">
                        <li class="dropdown">
                            <a href="#api" class="dropdown-toggle" data-toggle="dropdown">
                                API Documentation <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                                                                            </ul>
                        </li>
                        <li class="dropdown" id="charts-menu">
                            <a href="#charts" class="dropdown-toggle" data-toggle="dropdown">
                                Charts <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                <li>
                                    <a href="../graph_class.html">
                                        <i class="icon-list-alt"></i>&#160;Class hierarchy diagram
                                    </a>
                                </li>
                            </ul>
                        </li>
                        <li class="dropdown" id="reports-menu">
                            <a href="#reports" class="dropdown-toggle" data-toggle="dropdown">
                                Reports <b class="caret"></b>
                            </a>
                            <ul class="dropdown-menu">
                                <li>
                                    <a href="../errors.html">
                                        <i class="icon-list-alt"></i>&#160;Errors
                                    </a>
                                </li>
                                <li>
                                    <a href="../markers.html">
                                        <i class="icon-list-alt"></i>&#160;Markers
                                    </a>
                                </li>
                                <li>
                                    <a href="../deprecated.html">
                                        <i class="icon-list-alt"></i>&#160;Deprecated
                                    </a>
                                </li>
                            </ul>
                        </li>
                    </ul>
                </div>
            </div>
        </div>
        <div class="go_to_top">
            <a href="#___" style="color: inherit">Back to top&#160;&#160;<i class="icon-upload icon-white"></i></a>
        </div>
    </div>
    
    <div id="___" class="container">
        <noscript>
            <div class="alert alert-warning">
                Javascript is disabled; several features are only available if Javascript is enabled.
            </div>
        </noscript>

        
            
    <div class="row">

        <div class="span4">
            <div class="btn-group view pull-right" data-toggle="buttons-radio">
                <button class="btn details" title="Show descriptions and method names">
                    <i class="icon-list"></i></button><button class="btn simple" title="Show only method names">
                    <i class="icon-align-justify"></i>
                </button>
            </div>
            <ul class="side-nav nav nav-list">
                <li class="nav-header">
                    <i class="icon-map-marker"></i> Namespaces
                </li>
                    
    
            </ul>
        </div>

        <div class="span8 namespace-contents">
                
    
        <ul class="breadcrumb">
            <li><a href="../index.html"><i class="icon-th"></i></a></li>
                
    
    <li>
        <span class="divider">\</span><a href="../namespaces/default.html">\</a>
    </li>

        </ul>

        
                    <div class="namespace-indent">
                <h3><i class="icon-custom icon-constant"></i> Constants</h3>
                                        <div id="constant_DS" class="element ajax clickable constant" data-toggle="collapse" data-target="#constant_DS .collapse">
        <h1>DS<a href="../namespaces/default.html#constant_DS">¶</a></h1>
        <p class="short_description"></p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#constant_DS" class="more">« More »</a>    </div>

                                        <div id="constant_ROOT" class="element ajax clickable constant" data-toggle="collapse" data-target="#constant_ROOT .collapse">
        <h1>ROOT<a href="../namespaces/default.html#constant_ROOT">¶</a></h1>
        <p class="short_description"></p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#constant_ROOT" class="more">« More »</a>    </div>

                                        <div id="constant_APP_DIR" class="element ajax clickable constant" data-toggle="collapse" data-target="#constant_APP_DIR .collapse">
        <h1>APP_DIR<a href="../namespaces/default.html#constant_APP_DIR">¶</a></h1>
        <p class="short_description"></p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#constant_APP_DIR" class="more">« More »</a>    </div>

                                        <div id="constant_WEBROOT_DIR" class="element ajax clickable constant" data-toggle="collapse" data-target="#constant_WEBROOT_DIR .collapse">
        <h1>WEBROOT_DIR<a href="../namespaces/default.html#constant_WEBROOT_DIR">¶</a></h1>
        <p class="short_description"></p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#constant_WEBROOT_DIR" class="more">« More »</a>    </div>

                                        <div id="constant_WWW_ROOT" class="element ajax clickable constant" data-toggle="collapse" data-target="#constant_WWW_ROOT .collapse">
        <h1>WWW_ROOT<a href="../namespaces/default.html#constant_WWW_ROOT">¶</a></h1>
        <p class="short_description"></p>
        <div class="details collapse"></div>
        <a href="../namespaces/default.html#constant_WWW_ROOT" class="more">« More »</a>    </div>

                            </div>
        
                    <div class="namespace-indent">
                <h3><i class="icon-custom icon-class"></i> Classes, interfaces and traits</h3>
                
                
                                        <div id="class_ReminderShell" class="element ajax clickable class" data-toggle="collapse" data-target="#class_ReminderShell .collapse">
        <h1>ReminderShell<a href="../classes/ReminderShell.html">¶</a></h1>
        <p class="short_description">Study Reminder Shell</p>
        <div class="details collapse"><p>The study reminder shell will check for all appointments within the next 30 minutes. A reminder email will then be
sent to any user who is subscribed to reminder emails. This is typically run in a cron job.</p></div>
        <a href="../classes/ReminderShell.html" class="more">« More »</a>    </div>

                                        <div id="class_AppShell" class="element ajax clickable class" data-toggle="collapse" data-target="#class_AppShell .collapse">
        <h1>AppShell<a href="../classes/AppShell.html">¶</a></h1>
        <p class="short_description">Application Shell</p>
        <div class="details collapse"><p>Add your application-wide methods in the class below, your shells will inherit them.</p></div>
        <a href="../classes/AppShell.html" class="more">« More »</a>    </div>

                                        <div id="class_UpdateShell" class="element ajax clickable class" data-toggle="collapse" data-target="#class_UpdateShell .collapse">
        <h1>UpdateShell<a href="../classes/UpdateShell.html">¶</a></h1>
        <p class="short_description">RMS Update Shell</p>
        <div class="details collapse"><p>The update shell will update the RMS to the latest version.</p></div>
        <a href="../classes/UpdateShell.html" class="more">« More »</a>    </div>

                                        <div id="class_TfsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_TfsController .collapse">
        <h1>TfsController<a href="../classes/TfsController.html">¶</a></h1>
        <p class="short_description">TF Client Settings Controller</p>
        <div class="details collapse"><p>A TF client setting contains information about the fixed frame and associated environment.</p></div>
        <a href="../classes/TfsController.html" class="more">« More »</a>    </div>

                                        <div id="class_WidgetController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_WidgetController .collapse">
        <h1>WidgetController<a href="../classes/WidgetController.html">¶</a></h1>
        <p class="short_description">Widget Controller</p>
        <div class="details collapse"><p>The widget controller is the main page for editing ROS topics and widgets. This is made to keep the admin panel
cleaner instead of creating new pages for each.</p></div>
        <a href="../classes/WidgetController.html" class="more">« More »</a>    </div>

                                        <div id="class_AppointmentsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_AppointmentsController .collapse">
        <h1>AppointmentsController<a href="../classes/AppointmentsController.html">¶</a></h1>
        <p class="short_description">Study Session Appointments Controller</p>
        <div class="details collapse"><p>A user study session appointments contains information about the associated user (if any) and slot.</p></div>
        <a href="../classes/AppointmentsController.html" class="more">« More »</a>    </div>

                                        <div id="class_InteractiveWorldInterfaceController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_InteractiveWorldInterfaceController .collapse">
        <h1>InteractiveWorldInterfaceController<a href="../classes/InteractiveWorldInterfaceController.html">¶</a></h1>
        <p class="short_description">Interactive World Interface Controller</p>
        <div class="details collapse"><p>The interactive world interface controller. This allows experiments with the interactive world.</p></div>
        <a href="../classes/InteractiveWorldInterfaceController.html" class="more">« More »</a>    </div>

                                        <div id="class_RosbridgesController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_RosbridgesController .collapse">
        <h1>RosbridgesController<a href="../classes/RosbridgesController.html">¶</a></h1>
        <p class="short_description">rosbridge Servers Controller</p>
        <div class="details collapse"><p>A rosbridge server contains information about the protocol, host, port, and optional rosauth key.</p></div>
        <a href="../classes/RosbridgesController.html" class="more">« More »</a>    </div>

                                        <div id="class_ConditionsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_ConditionsController .collapse">
        <h1>ConditionsController<a href="../classes/ConditionsController.html">¶</a></h1>
        <p class="short_description">Study Conditions Controller</p>
        <div class="details collapse"><p>A user study condition contains information about the name of the condition and associated interface.</p></div>
        <a href="../classes/ConditionsController.html" class="more">« More »</a>    </div>

                                        <div id="class_ExperimentController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_ExperimentController .collapse">
        <h1>ExperimentController<a href="../classes/ExperimentController.html">¶</a></h1>
        <p class="short_description">Experiment Controller</p>
        <div class="details collapse"><p>The experiment controller has a single index action for the user study items.</p></div>
        <a href="../classes/ExperimentController.html" class="more">« More »</a>    </div>

                                        <div id="class_EnvironmentsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_EnvironmentsController .collapse">
        <h1>EnvironmentsController<a href="../classes/EnvironmentsController.html">¶</a></h1>
        <p class="short_description">Robot Environments Controller</p>
        <div class="details collapse"><p>A robot environment consists of a rosbridge server and MJPEG server.</p></div>
        <a href="../classes/EnvironmentsController.html" class="more">« More »</a>    </div>

                                        <div id="class_PagesController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_PagesController .collapse">
        <h1>PagesController<a href="../classes/PagesController.html">¶</a></h1>
        <p class="short_description">Content Pages Controller</p>
        <div class="details collapse"><p>Content pages contain information about the given RMS site. Each content page has a number of articles associated
with it. Menu items for these pages are automatically generated. The content page with the first index will be
defined as the homepage.</p></div>
        <a href="../classes/PagesController.html" class="more">« More »</a>    </div>

                                        <div id="class_GlobalController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_GlobalController .collapse">
        <h1>GlobalController<a href="../classes/GlobalController.html">¶</a></h1>
        <p class="short_description">Global Controller</p>
        <div class="details collapse"><p>The global settings controller has a single index action for the site settings menu items.</p></div>
        <a href="../classes/GlobalController.html" class="more">« More »</a>    </div>

                                        <div id="class_ContentController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_ContentController .collapse">
        <h1>ContentController<a href="../classes/ContentController.html">¶</a></h1>
        <p class="short_description">Content Controller</p>
        <div class="details collapse"><p>The content controller has a single index action for the site content menu items.</p></div>
        <a href="../classes/ContentController.html" class="more">« More »</a>    </div>

                                        <div id="class_AppController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_AppController .collapse">
        <h1>AppController<a href="../classes/AppController.html">¶</a></h1>
        <p class="short_description">Main Application Controller</p>
        <div class="details collapse"><p>Add your application-wide methods in the class below, your controllers will inherit them. This is useful for setting
global flags and menu variables for views. A global authorization function is also defined for all admin rights in
RMS controllers.</p></div>
        <a href="../classes/AppController.html" class="more">« More »</a>    </div>

                                        <div id="class_BasicInterfaceController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_BasicInterfaceController .collapse">
        <h1>BasicInterfaceController<a href="../classes/BasicInterfaceController.html">¶</a></h1>
        <p class="short_description">Basic Interface Controller</p>
        <div class="details collapse"><p>The basic interface controller. This is a simple interface with a camera feed and keyboard teleoperation.</p></div>
        <a href="../classes/BasicInterfaceController.html" class="more">« More »</a>    </div>

                                        <div id="class_EmailsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_EmailsController .collapse">
        <h1>EmailsController<a href="../classes/EmailsController.html">¶</a></h1>
        <p class="short_description">Email Settings Controller</p>
        <div class="details collapse"><p>Email settings can be used to send automated emails from the RMS. This includes features like password resets and
account creation emails.</p></div>
        <a href="../classes/EmailsController.html" class="more">« More »</a>    </div>

                                        <div id="class_RosController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_RosController .collapse">
        <h1>RosController<a href="../classes/RosController.html">¶</a></h1>
        <p class="short_description">ROS Controller</p>
        <div class="details collapse"><p>The ROS controller has a single index action for the ROS menu items.</p></div>
        <a href="../classes/RosController.html" class="more">« More »</a>    </div>

                                        <div id="class_ResourcesController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_ResourcesController .collapse">
        <h1>ResourcesController<a href="../classes/ResourcesController.html">¶</a></h1>
        <p class="short_description">Resource Servers Controller</p>
        <div class="details collapse"><p>Resource servers contain information about a Collada resource server for ros3djs.</p></div>
        <a href="../classes/ResourcesController.html" class="more">« More »</a>    </div>

                                        <div id="class_StudiesController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_StudiesController .collapse">
        <h1>StudiesController<a href="../classes/StudiesController.html">¶</a></h1>
        <p class="short_description">User Studies Controller</p>
        <div class="details collapse"><p>A user study contains information about the name of the study, access controls, and start/end dates.</p></div>
        <a href="../classes/StudiesController.html" class="more">« More »</a>    </div>

                                        <div id="class_TeleopsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_TeleopsController .collapse">
        <h1>TeleopsController<a href="../classes/TeleopsController.html">¶</a></h1>
        <p class="short_description">Teleoperation Settings Controller</p>
        <div class="details collapse"><p>A teleoperation contains information about the geometry_msgs/Twist topic and optional throttle rate.</p></div>
        <a href="../classes/TeleopsController.html" class="more">« More »</a>    </div>

                                        <div id="class_UsersController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_UsersController .collapse">
        <h1>UsersController<a href="../classes/UsersController.html">¶</a></h1>
        <p class="short_description">Users Controller</p>
        <div class="details collapse"><p>The users controller manages the account creation, modification, and removal of user and admin accounts. This
controller also manages basic authentication mechanisms used throughout the RMS.</p></div>
        <a href="../classes/UsersController.html" class="more">« More »</a>    </div>

                                        <div id="class_UrdfsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_UrdfsController .collapse">
        <h1>UrdfsController<a href="../classes/UrdfsController.html">¶</a></h1>
        <p class="short_description">URDF Settings Controller</p>
        <div class="details collapse"><p>An URDF contains information about the ROS parameter and Collada resources.</p></div>
        <a href="../classes/UrdfsController.html" class="more">« More »</a>    </div>

                                        <div id="class_LogsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_LogsController .collapse">
        <h1>LogsController<a href="../classes/LogsController.html">¶</a></h1>
        <p class="short_description">Study Logs Controller</p>
        <div class="details collapse"><p>Study logs contain log information from a study appointment.</p></div>
        <a href="../classes/LogsController.html" class="more">« More »</a>    </div>

                                        <div id="class_ImsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_ImsController .collapse">
        <h1>ImsController<a href="../classes/ImsController.html">¶</a></h1>
        <p class="short_description">Interactive Marker Settings Controller</p>
        <div class="details collapse"><p>An interactive marker contains information about the ROS interactive marker topic.</p></div>
        <a href="../classes/ImsController.html" class="more">« More »</a>    </div>

                                        <div id="class_SlotsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_SlotsController .collapse">
        <h1>SlotsController<a href="../classes/SlotsController.html">¶</a></h1>
        <p class="short_description">Study Session Slots Controller</p>
        <div class="details collapse"><p>A user study session slot contains information about the associated start/end time and associated
condition/environment.</p></div>
        <a href="../classes/SlotsController.html" class="more">« More »</a>    </div>

                                        <div id="class_SubscriptionsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_SubscriptionsController .collapse">
        <h1>SubscriptionsController<a href="../classes/SubscriptionsController.html">¶</a></h1>
        <p class="short_description">Email Subscriptions Controller</p>
        <div class="details collapse"><p>Email subscriptions control what types of automated emails a user can get.</p></div>
        <a href="../classes/SubscriptionsController.html" class="more">« More »</a>    </div>

                                        <div id="class_StreamsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_StreamsController .collapse">
        <h1>StreamsController<a href="../classes/StreamsController.html">¶</a></h1>
        <p class="short_description">MJPEG Server Streams Controller</p>
        <div class="details collapse"><p>A MJPEG server stream contains information about the ROS image topic and streaming parameters.</p></div>
        <a href="../classes/StreamsController.html" class="more">« More »</a>    </div>

                                        <div id="class_InterfaceController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_InterfaceController .collapse">
        <h1>InterfaceController<a href="../classes/InterfaceController.html">¶</a></h1>
        <p class="short_description">Main Interface Controller</p>
        <div class="details collapse"><p>All interfaces should extend the interface controller. This provides useful functions such as checking if a user is
authorized to view the given interface.</p></div>
        <a href="../classes/InterfaceController.html" class="more">« More »</a>    </div>

                                        <div id="class_MjpegsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_MjpegsController .collapse">
        <h1>MjpegsController<a href="../classes/MjpegsController.html">¶</a></h1>
        <p class="short_description">MJPEG Servers Controller</p>
        <div class="details collapse"><p>A MJPEG server contains information about the host and port.</p></div>
        <a href="../classes/MjpegsController.html" class="more">« More »</a>    </div>

                                        <div id="class_CarlDemoInterfaceController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_CarlDemoInterfaceController .collapse">
        <h1>CarlDemoInterfaceController<a href="../classes/CarlDemoInterfaceController.html">¶</a></h1>
        <p class="short_description">CARL Demo Interface Controller</p>
        <div class="details collapse"><p>The CARL demo interface controller. This interface will allow for navigation and manipulation controls.</p></div>
        <a href="../classes/CarlDemoInterfaceController.html" class="more">« More »</a>    </div>

                                        <div id="class_ArticlesController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_ArticlesController .collapse">
        <h1>ArticlesController<a href="../classes/ArticlesController.html">¶</a></h1>
        <p class="short_description">Content Articles Controller</p>
        <div class="details collapse"><p>Content articles contain information that is displayed on a given page. Each page has a number of content articles.</p></div>
        <a href="../classes/ArticlesController.html" class="more">« More »</a>    </div>

                                        <div id="class_SettingsController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_SettingsController .collapse">
        <h1>SettingsController<a href="../classes/SettingsController.html">¶</a></h1>
        <p class="short_description">Site Settings Controller</p>
        <div class="details collapse"><p>Site settings include options such as the site title, copyright message, and Google Analytics tracking. These
settings can only be edited by an admin.</p></div>
        <a href="../classes/SettingsController.html" class="more">« More »</a>    </div>

                                        <div id="class_IfacesController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_IfacesController .collapse">
        <h1>IfacesController<a href="../classes/IfacesController.html">¶</a></h1>
        <p class="short_description">Interfaces Controller</p>
        <div class="details collapse"><p>An interface contains information about the name of the interface and class definition. Ifaces is used to prevent
using the reserved PHP keyword interface.</p></div>
        <a href="../classes/IfacesController.html" class="more">« More »</a>    </div>

                                        <div id="class_MarkersController" class="element ajax clickable class" data-toggle="collapse" data-target="#class_MarkersController .collapse">
        <h1>MarkersController<a href="../classes/MarkersController.html">¶</a></h1>
        <p class="short_description">Marker Settings Controller</p>
        <div class="details collapse"><p>A marker contains information about the ROS 3D marker topic.</p></div>
        <a href="../classes/MarkersController.html" class="more">« More »</a>    </div>

                                        <div id="class_EmailConfig" class="element ajax clickable class" data-toggle="collapse" data-target="#class_EmailConfig .collapse">
        <h1>EmailConfig<a href="../classes/EmailConfig.html">¶</a></h1>
        <p class="short_description">Email Settings Configuration</p>
        <div class="details collapse"><p>The email settings configuration will dynamically load settings from the RMS database.</p></div>
        <a href="../classes/EmailConfig.html" class="more">« More »</a>    </div>

                                        <div id="class_DATABASE_CONFIG" class="element ajax clickable class" data-toggle="collapse" data-target="#class_DATABASE_CONFIG .collapse">
        <h1>DATABASE_CONFIG<a href="../classes/DATABASE_CONFIG.html">¶</a></h1>
        <p class="short_description"></p>
        <div class="details collapse"></div>
        <a href="../classes/DATABASE_CONFIG.html" class="more">« More »</a>    </div>

                                        <div id="class_Appointment" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Appointment .collapse">
        <h1>Appointment<a href="../classes/Appointment.html">¶</a></h1>
        <p class="short_description">Appointment Model</p>
        <div class="details collapse"><p>Appointments represent a reserved user study session slot. It contains information about the associated user (if
any) and slot.</p></div>
        <a href="../classes/Appointment.html" class="more">« More »</a>    </div>

                                        <div id="class_Protocol" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Protocol .collapse">
        <h1>Protocol<a href="../classes/Protocol.html">¶</a></h1>
        <p class="short_description">Protocols Model</p>
        <div class="details collapse"><p>Protocols define rosbridge transport protocols. Currently, these models cannot be modified via the admin interface as
they should remain constant for proper functionality.</p></div>
        <a href="../classes/Protocol.html" class="more">« More »</a>    </div>

                                        <div id="class_Teleop" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Teleop .collapse">
        <h1>Teleop<a href="../classes/Teleop.html">¶</a></h1>
        <p class="short_description">Telops Model</p>
        <div class="details collapse"><p>Teleops represent teleoperation settings. It contains information about the ROS topic and throttle rates.</p></div>
        <a href="../classes/Teleop.html" class="more">« More »</a>    </div>

                                        <div id="class_Environment" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Environment .collapse">
        <h1>Environment<a href="../classes/Environment.html">¶</a></h1>
        <p class="short_description">Environments Model</p>
        <div class="details collapse"><p>Environments are linked to a rosbridge and MJPEG server. Each has a unique name.</p></div>
        <a href="../classes/Environment.html" class="more">« More »</a>    </div>

                                        <div id="class_Im" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Im .collapse">
        <h1>Im<a href="../classes/Im.html">¶</a></h1>
        <p class="short_description">Ims Model</p>
        <div class="details collapse"><p>Interactive markers represent ROS interactive marker settings. It contains information about the ROS topic.</p></div>
        <a href="../classes/Im.html" class="more">« More »</a>    </div>

                                        <div id="class_Log" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Log .collapse">
        <h1>Log<a href="../classes/Log.html">¶</a></h1>
        <p class="short_description">Log Model</p>
        <div class="details collapse"><p>Logs are used to store study log data.</p></div>
        <a href="../classes/Log.html" class="more">« More »</a>    </div>

                                        <div id="class_User" class="element ajax clickable class" data-toggle="collapse" data-target="#class_User .collapse">
        <h1>User<a href="../classes/User.html">¶</a></h1>
        <p class="short_description">Users Model</p>
        <div class="details collapse"><p>Users can either be of type admin or basic. Information about the user's name and email are stored inside their
account as well as login information.</p></div>
        <a href="../classes/User.html" class="more">« More »</a>    </div>

                                        <div id="class_Stream" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Stream .collapse">
        <h1>Stream<a href="../classes/Stream.html">¶</a></h1>
        <p class="short_description">Streams Model</p>
        <div class="details collapse"><p>Streams represent a MJPEG server streams. It contains information about the ROS image topic and streaming parameters.</p></div>
        <a href="../classes/Stream.html" class="more">« More »</a>    </div>

                                        <div id="class_Email" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Email .collapse">
        <h1>Email<a href="../classes/Email.html">¶</a></h1>
        <p class="short_description">SMTP Email Settings Model</p>
        <div class="details collapse"><p>SMTP email settings contain information about email server settings.</p></div>
        <a href="../classes/Email.html" class="more">« More »</a>    </div>

                                        <div id="class_AppModel" class="element ajax clickable class" data-toggle="collapse" data-target="#class_AppModel .collapse">
        <h1>AppModel<a href="../classes/AppModel.html">¶</a></h1>
        <p class="short_description">Main Application Model</p>
        <div class="details collapse"><p>The application model base class contains useful functions and definitions for all models in the RMS.</p></div>
        <a href="../classes/AppModel.html" class="more">« More »</a>    </div>

                                        <div id="class_Collada" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Collada .collapse">
        <h1>Collada<a href="../classes/Collada.html">¶</a></h1>
        <p class="short_description">Colladas Model</p>
        <div class="details collapse"><p>Colladas define threejs Collada loaders. Currently, these models cannot be modified via the admin interface as they
should remain constant for proper functionality.</p></div>
        <a href="../classes/Collada.html" class="more">« More »</a>    </div>

                                        <div id="class_Slot" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Slot .collapse">
        <h1>Slot<a href="../classes/Slot.html">¶</a></h1>
        <p class="short_description">Slot Model</p>
        <div class="details collapse"><p>Slots represent a user study session slot. It contains information about the associated interface, environment, and
start/end time.</p></div>
        <a href="../classes/Slot.html" class="more">« More »</a>    </div>

                                        <div id="class_Page" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Page .collapse">
        <h1>Page<a href="../classes/Page.html">¶</a></h1>
        <p class="short_description">Pages Model</p>
        <div class="details collapse"><p>Pages display a series of articles as content on the RMS. Each page has many articles. A page has a title and menu
entry name.</p></div>
        <a href="../classes/Page.html" class="more">« More »</a>    </div>

                                        <div id="class_Condition" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Condition .collapse">
        <h1>Condition<a href="../classes/Condition.html">¶</a></h1>
        <p class="short_description">Condition Model</p>
        <div class="details collapse"><p>Conditions represent a user study condition. It contains information about the name and associated interface.</p></div>
        <a href="../classes/Condition.html" class="more">« More »</a>    </div>

                                        <div id="class_Subscription" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Subscription .collapse">
        <h1>Subscription<a href="../classes/Subscription.html">¶</a></h1>
        <p class="short_description">Subscriptions Model</p>
        <div class="details collapse"><p>Subscription settings allow users to enable/disable automated emails.</p></div>
        <a href="../classes/Subscription.html" class="more">« More »</a>    </div>

                                        <div id="class_Urdf" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Urdf .collapse">
        <h1>Urdf<a href="../classes/Urdf.html">¶</a></h1>
        <p class="short_description">Urdfs Model</p>
        <div class="details collapse"><p>URDF settings. It contains information about the ROS parameters and Collada loaders.</p></div>
        <a href="../classes/Urdf.html" class="more">« More »</a>    </div>

                                        <div id="class_Tf" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Tf .collapse">
        <h1>Tf<a href="../classes/Tf.html">¶</a></h1>
        <p class="short_description">Tfs Model</p>
        <div class="details collapse"><p>TFs represent TF client settings. It contains information about the fixed frame and throttle rates.</p></div>
        <a href="../classes/Tf.html" class="more">« More »</a>    </div>

                                        <div id="class_Resource" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Resource .collapse">
        <h1>Resource<a href="../classes/Resource.html">¶</a></h1>
        <p class="short_description">Resource Model</p>
        <div class="details collapse"><p>Resources represent Collada resource servers for use with ros3djs.</p></div>
        <a href="../classes/Resource.html" class="more">« More »</a>    </div>

                                        <div id="class_Article" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Article .collapse">
        <h1>Article<a href="../classes/Article.html">¶</a></h1>
        <p class="short_description">Article Model</p>
        <div class="details collapse"><p>Articles are used to store content on a given page. They consist of a title and the associated content.</p></div>
        <a href="../classes/Article.html" class="more">« More »</a>    </div>

                                        <div id="class_Setting" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Setting .collapse">
        <h1>Setting<a href="../classes/Setting.html">¶</a></h1>
        <p class="short_description">Settings Model</p>
        <div class="details collapse"><p>RMS settings contain information about parameters such as the site name and copyright message.</p></div>
        <a href="../classes/Setting.html" class="more">« More »</a>    </div>

                                        <div id="class_Type" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Type .collapse">
        <h1>Type<a href="../classes/Type.html">¶</a></h1>
        <p class="short_description">Types Model</p>
        <div class="details collapse"><p>Types define user study log data types. Currently, these models cannot be modified via the admin interface as they
should remain constant for proper functionality.</p></div>
        <a href="../classes/Type.html" class="more">« More »</a>    </div>

                                        <div id="class_Role" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Role .collapse">
        <h1>Role<a href="../classes/Role.html">¶</a></h1>
        <p class="short_description">Roles Model</p>
        <div class="details collapse"><p>Roles define different user types for the RMS. Currently, these models cannot be modified via the admin interface as
they should remain constant for proper functionality.</p></div>
        <a href="../classes/Role.html" class="more">« More »</a>    </div>

                                        <div id="class_Study" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Study .collapse">
        <h1>Study<a href="../classes/Study.html">¶</a></h1>
        <p class="short_description">Study Model</p>
        <div class="details collapse"><p>Studies represent a user study. It contains information about the name, access settings, and start/end dates.</p></div>
        <a href="../classes/Study.html" class="more">« More »</a>    </div>

                                        <div id="class_Marker" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Marker .collapse">
        <h1>Marker<a href="../classes/Marker.html">¶</a></h1>
        <p class="short_description">Markers Model</p>
        <div class="details collapse"><p>Markers represent ROS 3D marker settings. It contains information about the ROS topic.</p></div>
        <a href="../classes/Marker.html" class="more">« More »</a>    </div>

                                        <div id="class_Iface" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Iface .collapse">
        <h1>Iface<a href="../classes/Iface.html">¶</a></h1>
        <p class="short_description">RMS Interfaces Model</p>
        <div class="details collapse"><p>Interfaces represent an RMS interface. It contains information about the name and class information. Ifaces is used
to prevent using the reserved PHP keyword interface.</p></div>
        <a href="../classes/Iface.html" class="more">« More »</a>    </div>

                                        <div id="class_Rosbridge" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Rosbridge .collapse">
        <h1>Rosbridge<a href="../classes/Rosbridge.html">¶</a></h1>
        <p class="short_description">Rosbridges Model</p>
        <div class="details collapse"><p>Rosbridges represent a rosbridge servers. It contains information about the port, host, and protocol.</p></div>
        <a href="../classes/Rosbridge.html" class="more">« More »</a>    </div>

                                        <div id="class_Mjpeg" class="element ajax clickable class" data-toggle="collapse" data-target="#class_Mjpeg .collapse">
        <h1>Mjpeg<a href="../classes/Mjpeg.html">¶</a></h1>
        <p class="short_description">Mjpegs Model</p>
        <div class="details collapse"><p>Mjpegs represent a MJPEG servers. It contains information about the port and host.</p></div>
        <a href="../classes/Mjpeg.html" class="more">« More »</a>    </div>

                                        <div id="class_RmsHelper" class="element ajax clickable class" data-toggle="collapse" data-target="#class_RmsHelper .collapse">
        <h1>RmsHelper<a href="../classes/RmsHelper.html">¶</a></h1>
        <p class="short_description">RMS Helper</p>
        <div class="details collapse"><p>The RMS helper adds useful functions for making use of the RMS JavaScript library.</p></div>
        <a href="../classes/RmsHelper.html" class="more">« More »</a>    </div>

                                        <div id="class_AppHelper" class="element ajax clickable class" data-toggle="collapse" data-target="#class_AppHelper .collapse">
        <h1>AppHelper<a href="../classes/AppHelper.html">¶</a></h1>
        <p class="short_description">Application Helper</p>
        <div class="details collapse"><p>Add your application-wide methods in the class below, your helpers will inherit them.</p></div>
        <a href="../classes/AppHelper.html" class="more">« More »</a>    </div>

                            </div>
            
    
        </div>
    </div>
    </div>

        <footer class="span12">
            Template is built using <a href="http://twitter.github.com/bootstrap/">Twitter Bootstrap 2</a> and icons provided by
            <a href="http://glyphicons.com/">Glyphicons</a>.<br/>
            Documentation is powered by <a href="http://www.phpdoc.org/">phpDocumentor </a> and<br/>
            generated on Fri, 08 Aug 2014 10:46:31 -0400.<br/>
    </footer>
    </body>
</html>
